Skip to content

docs: accuracy pass across all .md files (waves 6-7, harness v22, 5 levels)#56

Merged
SethMorrowSoftware merged 1 commit into
mainfrom
claude/gifted-faraday-n90yba
Jun 17, 2026
Merged

docs: accuracy pass across all .md files (waves 6-7, harness v22, 5 levels)#56
SethMorrowSoftware merged 1 commit into
mainfrom
claude/gifted-faraday-n90yba

Conversation

@SethMorrowSoftware

Copy link
Copy Markdown
Owner

A full documentation accuracy pass — bringing every descriptive .md file in line with the software's actual state after Waves 6–7 (and the Kit work that has carried the harness to v22). Driven by a 6-agent parallel audit (each agent verified its claims against the real code), then reviewed and reconciled.

What was stale → fixed

Fact Was Now
Kit handlers 260+ 312
Harness v12, ~125 assertions v22, ~180 across 37 tests
Platformer "four / three level" 5 levels (+ SCORCHED DUNES)
b2Version() (kit-guide) 3 4
Examples micro-game implied live 6 examples; micro-game retired in Wave 5
CONTRIBUTING.md links dead (file doesn't exist) repointed at real targets

By file

  • CLAUDE.md — handler count, harness v22/37-tests, examples paragraph, CONTRIBUTING heading.
  • README.md / dist/INSTALL.md — "four"→"five" levels, platformer bullet, dead CONTRIBUTING link.
  • docs/building.md — the "distribution zip" section described the old loose-lib layout; rewritten for the bundled-in-extension layout make-release.py actually ships.
  • docs/expansion-prep.md — the wave-status table + roadmap (Waves 1–7 COMPLETE, Wave 8 the only item left; v22 baseline).
  • docs/game-engine-spec.md — v22/~180 checks; b2kPlayerAnims/b2kPlayerState gain the Wave 5 slots; deferred→landed.
  • docs/kit-guide.mdb2Version 3→4, micro-game §20 reframed as a retired example whose pattern is preserved, added b2kSheetPersist.
  • docs/kit-reference.md — added the airDash knob.
  • platformer header — "FOUR-LEVEL"→FIVE, added the L5 entry, wove the bestiary II creatures into the L1/L2/L4 blurbs.

Deliberately left alone

  • plan.md and CHANGELOG.md — append-only historical logs; their per-commit entries ("harness v10", "three-level platformer") are correct as history.
  • api-reference.md, architecture.md, getting-started.md, prebuilt/README.md — audited, found already accurate.
  • Dated design sections in expansion-prep (§9/§10) — historical milestone records.

Smart-quote scan clean; static gates pass.

A couple of agent flags for your call (not fixed): CLAUDE.md's "5 Kit bugs : 5 harness bugs" scoreboard couldn't be verified against a current tally; and the multithreaded-world API (ABI 4) is undocumented across docs/ — an omission, not an inaccuracy, so out of scope for this pass.

🤖 Generated with Claude Code

https://claude.ai/code/session_0181ux7LaTgpy4cosAcL4dia


Generated by Claude Code

Brings every descriptive doc in line with the software's actual state after
Waves 6-7 (and the Kit work that has carried the harness to v22). Driven by a
6-agent parallel audit; plan.md and CHANGELOG (append-only history) untouched.

- CLAUDE.md: 260+ -> 312 Kit handlers; harness ~125/v12 -> ~180 across 37
  tests / v22; "(from CONTRIBUTING.md)" dropped (no such file); the examples
  paragraph (spike -> spike-gamekit; platformer = 5 levels + bestiary I/II;
  slingshot 3 levels; micro-game retired in Wave 5).
- README.md / dist/INSTALL.md: "four levels" -> five; platformer bullet
  expanded (5 levels, the bestiary, joints, audio); the dead CONTRIBUTING.md
  link repointed at real targets. (Slingshot's correct "3 levels" left alone.)
- docs/building.md: the "distribution zip" section described the OLD loose-lib
  layout; rewritten for the bundled-in-extension layout make-release.py ships.
- docs/expansion-prep.md: the wave-status table + roadmap (Waves 1-7 COMPLETE,
  Wave 8 the only remaining item; baseline harness v22; the three-level
  platformer noted as a historical milestone, now five). Dated design sections
  left as history.
- docs/game-engine-spec.md: ~93 -> v22/~180 checks; b2kPlayerAnims gains
  pWall/pDash; b2kPlayerState gains wallslide/dash; the Wave 5 moves moved
  from "still ahead" to "landed".
- docs/kit-guide.md: b2Version 3 -> 4; the micro-game section reframed as a
  retired example whose pattern is preserved; added b2kSheetPersist.
- docs/kit-reference.md: added the airDash player knob (the one omitted).
- platformer header: "FOUR-LEVEL" -> FIVE; added the LEVEL 5 (SCORCHED DUNES)
  entry; wove the bestiary II creatures into the L1/L2/L4 blurbs + the feature
  summary; "the last flag" moved to L5.

api-reference.md, architecture.md, getting-started.md, prebuilt/README.md were
audited and found already accurate (no change). Static gates pass.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0181ux7LaTgpy4cosAcL4dia
@SethMorrowSoftware SethMorrowSoftware marked this pull request as ready for review June 17, 2026 17:15
@SethMorrowSoftware SethMorrowSoftware merged commit 7f4e241 into main Jun 17, 2026
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants